################################################################################
# DISCLAIMER
################################################################################
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

################################################################################
# PACKAGE CONTENTS
################################################################################
The provided binaries are only for Windows. If you want to test ClonEvol on 
Linux (Debian and derivatives should work at least), you can contact the author: 
a.hanjalic[AT]student.rug.nl.

################################################################################
# MINIMUM System requirements
################################################################################
- OS:       Windows XP or higher (though any NT version is expected to work)
- CPU:      Anything that will run the OS
- RAM:      Anything that will run the OS
- STORAGE:  100MB for installation, 2GB+ free space (depending on project)

################################################################################
# RECOMMENDED System requirements
################################################################################
- OS:       Windows XP or higher (though any NT version is expected to work)
- CPU:      Quad-core x86 CPU
- RAM:      4GB+
- STORAGE:  SSD with 10GB+ free space*

*ClonEvol performs many disk I/O operations during the mining procedure, that
will take a very long time on an conventional HDD. Either run ClonEvol from an
SSD or make an RAMdisk - many solutions can be found on Google. The contents for
a repo Like FileZilla (~5200 revisions) used about 1.2GB of space.

################################################################################
# Installation of dependencies
################################################################################
ClonEvol is a toolchain based in SVN, Doxygen and Simian. ClonEvol must be able 
to start these applications from the command line. This can be achieved by:
1. Installing the applications and adding the locations to your systems PATH
   environment variable (Google "path environment variable").
2. The other solution is to extract the applications into the same directory
   where ClonEvol.exe is located.
  
- SVN:      You need a command-line SVN client - TortoiseSVN is NOT sufficient!
            http://www.sliksvn.com/en/download
- Doxygen:  ClonEvol is tested with Doxygen 1.8.3.1, newer _should_ be ok...
			Either use the installer or extract the binaries into ClonEvol dir.
            http://www.stack.nl/~dimitri/doxygen/download.html
- Simian:   Simian comes with a non-free license for non-commercial use...
            http://www.harukizaemon.com/simian/get_it_now.html
            
Finally, you will have to rename simian-X.X.XX.exe to simian.exe

CheckDependencies.bat will check whether the required applications can be found;
The path of each found application will be shown, otherwise an error is printed.

################################################################################
# Using ClonEvol / FAQ
################################################################################
Usage of ClonEvol is (hopefully) straight-forward:
Choose a project name, set the URL, hit start. If the URL is OK, you will get an
overview of the files and changelogs in a few seconds up to a few minutes
(depending on the speed of the repository).
 - All URL's supported by SVN can be used, e.g. also svn://svn.myproject.org/
 - If you want to mine a password-protected repository, do check-out outside
   ClonEvol and let SVN save the password. ClonEvol should now be able to mine
   your password-protected repository.
   
Once you have the first overview, details can be acquired for revisions, by
selecting a revision range and hit 'Get revisions' under the sliders. The LOG
shows more details about the progress.

DO NOT MINE TEN THOUSANDS OF REVISIONS AT ONCE. This will take a lot of time,
and IF anything goes wrong, you will LOSE ALL PROGRESS. Better is to mine one
thousand revisions ten times, as these will be stored. Moreover, you have the
opportunity to view the partial data.

DO NOT MINE THE SAME PROJECT FROM MULTIPLE INSTANCES. There are no locks on
the files and you will probably just get rubbish data. If you still insist,
make sure that the scope extraction is not run at the same time from multiple
instances.

DO NOT MINE MULTIPLE PROJECTS FROM THE SAME REPOSITORY AT THE SAME TIME. Other
people actually work on these repositories, and ClonEvol is not very friendly
to the servers. Moreover, you risk having your IP banned - YOU ARE WARNED.

################################################################################
# BUG REPORTS
################################################################################
ClonEvol is not a final product. Expect crashes and other inconveniences. Still,
it is highly appreciated if you report the problems you encounter. You can send
a mail to a.hanjalic[AT]student.rug.nl. Please report
 - What project you were using (if possible, provide the database too)
 - What you were trying to do (which button/slider/etc you used at that moment)